v2.0.0 (2025-02-09)

Breaking

    refactor!: rename python package serializable -> py_serializable (#155)

    The python package was renamed from serializable to py_serializable.
    Therefore, you need to adjust your imports.

    The following shows a quick way to adjust imports in the most efficient way.
    OLD imports

    import serializable
    from serializable import ViewType, XmlArraySerializationType, XmlStringSerializationType
    from serializable.helpers import BaseHelper, Iso8601Date

ADJUSTED imports

import py_serializable as serializable
from py_serializable import ViewType, XmlArraySerializationType, XmlStringSerializationType
from py_serializable.helpers import BaseHelper, Iso8601Date

    see migration path: https://py-serializable.readthedocs.io/en/refactor-rename-installable-py_serializable/migration.html

Unknown

    Delete duplicate CODEOWNERS (#156)

    we have a codeowners file in root already (b64cdde)

What's Changed

    chore(deps-dev): update mypy requirement from 1.11.2 to 1.12.0 by @dependabot in #143
    chore(deps-dev): update mypy requirement from 1.12.0 to 1.13.0 by @dependabot in #145
    chore(deps-dev): update flake8-bugbear requirement from 24.8.19 to 24.10.31 by @dependabot in #146
    chore(deps-dev): update flake8-bugbear requirement from 24.10.31 to 24.12.12 by @dependabot in #150
    chore(deps-dev): update mypy requirement from 1.13.0 to 1.14.1 by @dependabot in #154
    Delete duplicate CODEOWNERS by @jkowalleck in #156
    chore(docs): chanelog contains only relevant by @jkowalleck in #157
    chore(docs): recreate changelog by @jkowalleck in #158
    chore(deps): bump actions/upload-artifact from 3 to 4 by @dependabot in #37
    refactor!: rename python package serializable -> py_serializable by @jkowalleck in #155
    chore(deps): update sphinx requirement from <8,>=7.2.6 to >=7.2.6,<9 by @dependabot in #127

## Changes in version 0.14.1

**Released on March 29th, 2025.**

* Issue #263: fix release tarball by relying on `make dist`.

* Document ATF to Kyua mappings for metadata properties.

* Support `require.diskspace` ATF metadata property.

* Support backwards compatible `unprivileged_user` metadata property for ease
  of use dealing with ATF vs Kyua.

* Fix building from source by tracking `utils/process/Kyuafile.in` and
  `engine/execenv/execenv_fwd.hpp` with automake.

## Changes in version 0.14

**Released on December 31st, 2024.**

* Replace `--with-atf` with `--enable-atf`. The latter must be specified
  to enable ATF support and the Kyua tests by proxy.

* Require newer versions of ATF (0.21) and Lutok (0.5). This is being done
  as part of a multi-phase deprecation of pre-C++11 environments.

* Vendor the ATF m4 files from the freebsd/atf repo.

* Translate `is_exclusive` metadata to its ATF counterpart.

* Issue #236: fix accidental test forkbomb in specific user environments
  with `integration` tests by avoiding infinite recursion calling kyua.

* Fix the build on Ubuntu 24.04.

- execenv support added. This FreeBSD-specific feature allows tests to be
  executed in jails.

* Issue #169: Remove deprecated `readdir_r` use.

* Fix build issue on more recent versions of MacOS.

* Fix build issue on IllumOS.

* Fix issues with PID reuse in testcases.

* Escape characters captured from stderr and stdout in HTML output.

* `integration/cmd_report_test:verbose`: fix regular expression used in
  tests which would break in certain user environments.

* Add Cirrus CI support for testing Kyua on FreeBSD.

* Remove `UTILS_UNUSED_PARAM` macro.

* Fix document rendering with newer versions of doxygen.

* Issue #152: explicitly require C++11 language features when compiling Kyua.
  Remove `std::shared_ptr` compatibility header, `utils/shared_ptr.hpp`.

* Fix `igor` and `mandoc -Tlint` reported issues with generated manpages.

* Issue #167: fix typos in kyua(1) manpage.

## Changes in version 0.13

**Released on August 26th, 2016.**

* Fixed execution of test cases as an unprivileged user, at least under
  NetBSD 7.0.  Kyua-level failures were probably a regression introduced
  in Kyua 0.12, but the underlying may have existed for much longer:
  test cases might have previously failed for mysterious reasons when
  running under an unprivileged user.

* Issue #134: Fixed metadata test broken on 32-bit platforms.

* Issue #139: Added per-test case start/end timestamps to all reports.

* Issue #156: Fixed crashes due to the invalid handling of cleanup
  routine data and triggered by the reuse of PIDs in long-running Kyua
  instances.

* Issue #159: Fixed TAP parser to ignore case while matching `TODO` and
  `SKIP` directives, and to also recognize `Skipped`.

* Fixed potential crash due to a race condition in the unprogramming of
  timers to control test deadlines.


## Changes in version 0.12

**Released on November 22nd, 2015.**

This is a huge release and marks a major milestone for Kyua as it finally
implements a long-standing feature request: the ability to execute test
cases in parallel.  This is a big deal because test cases are rarely
CPU-bound: running them in parallel yields much faster execution times for
large test suites, allowing faster iteration of changes during development.

As an example: the FreeBSD test suite as of this date contains 3285 test
cases.  With sequential execution, a full test suite run takes around 12
minutes to complete, whereas on a 4-core machine with a high level of
parallelism it takes a little over 1 minute.

Implementing parallel execution required rewriting most of Kyua's core and
partly explains explains why there has not been a new release for over a
year.  The current implementation is purely subprocess-based, which works
but has some limitations and has resulted in a core that is really complex
and difficult to understand.  Future versions will investigate the use of
threads instead for a simplified programming model and additional
parallelization possibilities.

* Issue #2: Implemented support to execute test cases in parallel when
  invoking `kyua test`.  Parallel execution is *only* enabled when the new
  `parallelism` configuration variable is set to a value greater than `1`.
  The default behavior is still to run tests sequentially because some test
  suites contain test cases with side-effects that might fail when run in
  parallel.  To resolve this, the new metadata property `is_exclusive` can
  be set to `true` on a test basis to indicate that the test must be run on
  its own.

* Known regression: Running `kyua debug` on a TAP-based test program does
  not currently report the output in real time.  The output will only be
  displayed once the test program completes.  This is a shortcoming of
  the new parallel execution engine and will be resolved.

* Removed the external C-based testers code in favor of the new built-in
  implementations.  The new approach feels significantly faster than the
  previous one.

* Fixed the handling of relative paths in the `fs.*` functions available
  in `Kyuafile`s.  All paths are now resolved relative to the location of
  the caller `Kyuafile`.  `Kyuafile.top` has been updated with these
  changes and you should update custom copies of this file with the new
  version.

* Changed temporary directory creation to always grant search
  permissions on temporary directories.  This is to prevent potential
  problems when running Kyua as root and executing test cases that require
  dropping privileges (as they may later be unable to use absolute paths
  that point inside their work directory).

* The cleanup of work directories does not longer attempt to deal with
  mount points.  If a test case mounts a file system and forgets to unmount
  it, the mount point will be left behind.  It is now the responsibility of
  the test case to clean after itself.  The reasons for this change are
  simplicity and clarity: there are many more things that a test case can
  do that have side-effects on the system and Kyua cannot protect against
  them all, so it is better to just have the test undo anything it might
  have done.

* Improved `kyua report --verbose` to properly handle environment
  variables with continuation lines in them, and fixed the integration
  tests for this command to avoid false negatives.

* Changed the configuration file format to accept the definition of
  unknown variables without declaring them local.  The syntax version
  number remains at 2.  This is to allow configuration files for newer Kyua
  versions to work on older Kyua versions, as there is no reason to forbid
  this.

* Fixed stacktrace gathering with FreeBSD's ancient version of GDB.
  GDB 6.1.1 (circa 2004) does not have the `-ex` flag so we need to
  generate a temporary GDB script and feed it to GDB with `-x` instead.

* Issue #136: Fixed the XML escaping in the JUnit output so that
  non-printable characters are properly handled when they appear in the
  process's stdout or stderr.

* Issue #141: Improved reporting of errors triggered by sqlite3.  In
  particular, all error messages are now tagged with their corresponding
  database filename and, if they are API-level errors, the name of the
  sqlite3 function that caused them.

* Issue #144: Improved documentation on the support for custom properties
  in the test metadata.

* Converted the `INSTALL`, `NEWS`, and `README` distribution documents to
  Markdown for better formatting online.


## Changes in version 0.11

**Released on October 23rd, 2014.**

* Added support to print the details of all test cases (metadata and
  their output) to `report`.  This is via a new `--verbose` flag which
  replaces the previous `--show-context`.

* Added support to specify the amount of physical disk space required
  by a test case.  This is in the form of a new `required_disk_space`
  metadata property, which can also be provided by ATF test cases as
  `require.diskspace`.

* Assimilated the contents of all the `kyua-*-tester(1)` and
  `kyua-*-interface(7)` manual pages into more relevant places.  In
  particular, added more details on test program registration and their
  metadata to `kyuafile(5)`, and added `kyua-test-isolation(7)`
  describing the isolation features of the test execution.

* Assimilated the contents of all auxiliary manual pages, including
  `kyua-build-root(7)`, `kyua-results-files(7)`, `kyua-test-filters(7)`
  and `kyua-test-isolation(7)`, into the relevant command-specific
  manual pages.  This is for easier discoverability of relevant
  information when reading how specific Kyua commands work.

* Issue #30: Plumbed through support to query configuration variables
  from ATF's test case heads.  This resolves the confusing situation
  where test cases could only do this from their body and cleanup
  routines.

* Issue #49: Extended `report` to support test case filters as
  command-line arguments.  Combined with `--verbose`, this allows
  inspecting the details of a test case failure after execution.

* Issue #55: Deprecated support for specifying `test_suite` overrides on
  a test program basis.  This idiom should not be used but support for
  it remains in place.

* Issue #72: Added caching support to the `getcwd(3)` test in configure
  so that the result can be overriden for cross-compilation purposes.

* Issue #83: Changed manual page headings to include a `kyua` prefix in
  their name.  This prevents some possible confusion when displaying,
  for example, the `kyua-test` manual page with a plain name of `test`.

* Issue #84: Started passing test-suite configuration variables to plain
  and TAP test programs via the environment.  The name of the
  environment variables set this way is prefixed by `TEST_ENV_`, so a
  configuration variable of the form
  `test_suites.some_name.allow_unsafe_ops=yes` in `kyua.conf` becomes
  `TEST_ENV_allow_unsafe_ops=YES` in the environment.

* Issues #97 and #116: Fixed the build on Illumos.

* Issue #102: Set `TMPDIR` to the test case's work directory when running
  the test case.  If the test case happens to use the `mktemp(3)` family
  of functions (due to misunderstandings on how Kyua works or due to
  the reuse of legacy test code), we don't want it to easily escape the
  automanaged work directory.

* Issue #103: Started being more liberal in the parsing of TAP test
  results by treating the number in `ok` and `not ok` lines as optional.

* Issue #105: Started using tmpfs instead of md as a temporary file
  system for tests in FreeBSD so that we do not leak `md(4)` devices.

* Issue #109: Changed the privilege dropping code to start properly
  dropping group privileges when `unprivileged_user` is set.  Also fixes
  `testers/run_test:fork_wait__unprivileged_group`.

* Issue #110: Changed `help` to display version information and clarified
  the purpose of the `about` command in its documentation.

* Issue #111: Fixed crash when defining a test program in a `Kyuafile`
  that has not yet specified the test suite name.

* Issue #114: Improved the `kyuafile(5)` manual page by clarifying the
  restrictions of the `include()` directive and by adding abundant
  examples.


## Changes in version 0.10

**Experimental version released on August 14th, 2014.**

* Merged `kyua-cli` and `kyua-testers` into a single `kyua` package.

* Dropped the `kyua-atf-compat` package.

* Issue #100: Do not try to drop privileges to `unprivileged_user` when we
  are already running as an unprivileged user.  Doing so is not possible
  and thus causes spurious test failures when the current user is not
  root and the current user and `unprivileged_user` do not match.

* Issue #79: Mention `kyua.conf(5)` in the *See also* section of `kyua(1)`.

* Issue #75: Change the `rewrite__expected_signal__bad_arg` test in
  `testers/atf_result_test` to use a different signal value.  This is to
  prevent triggering a core dump that made the test fail in some platforms.


## Changes in kyua-cli version 0.9

**Experimental version released on August 8th, 2014.**

Major changes:

The internal architecture of Kyua to record the results of test suite
runs has completely changed in this release.  Kyua no longer stores all
the different test suite run results as different "actions" within the
single `store.db` database.  Instead, Kyua now generates a separate
results file inside `~/.kyua/store/` for every test suite run.

Due to the complexity involved in the migration process and the little
need for it, this is probably going to be the only release where the
`db-migrate` command is able to convert an old `store.db` file to the
new scheme.

Changes in more detail:

* Added the `report-junit` command to generate JUnit XML result files.
  The output has been verified to work within Jenkins.

* Switched to results files specific to their corresponding test suite
  run.  The unified `store.db` file is now gone: `kyua test` creates a
  new results file for every invocation under `~/.kyua/store/` and the
  `kyua report*` commands are able to locate the latest file for a
  corresponding test suite automatically.

* The `db-migrate` command takes an old `store.db` file and generates
  one results file for every previously-recorded action, later deleting
  the `store.db` file.

* The `--action` flag has been removed from all commands that accepted
  it.  This has been superseded by the tests results files.

* The `--store` flag that many commands took has been renamed to
  `--results-file` in line with the semantical changes.

* The `db-exec` command no longer creates an empty database when none
  is found.  This command is now intended to run only over existing
  files.


## Changes in kyua-testers version 0.3

**Experimental version released on August 8th, 2014.**

* Made the testers set a "sanitized" value for the `HOME` environment
  variable where, for example, consecutive and trailing slashes have
  been cleared.  Mac OS X has a tendency to append a trailing slash to
  the value of `TMPDIR`, which can cause third-party tests to fail if
  they compare `${HOME}` with `$(pwd)`.

* Issues #85, #86, #90 and #92: Made the TAP parser more complete: mark
  test cases reported as `TODO` or `SKIP` as passed; handle skip plans;
  ignore lines that look like `ok` and `not ok` but aren't results; and
  handle test programs that report a pass but exit with a non-zero code.


## Changes in kyua-cli version 0.8

**Experimental version released on December 7th, 2013.**

* Added support for Lutok 0.4.

* Issue #24: Plug the bootstrap tests back into the test suite.  Fixes
  in `kyua-testers` 0.2 to isolate test cases into their own sessions
  should allow these to run fine.

* Issue #74: Changed the `kyuafile(5)` parser to automatically discover
  existing tester interfaces.  The various `*_test_program()` functions
  will now exist (or not) based on tester availability, which simplifies
  the addition of new testers or the selective installation of them.


## Changes in kyua-testers version 0.2

**Experimental version released on December 7th, 2013.**

* Issue #74: Added the `kyua-tap-tester`, a new backend to interact with
  test programs that comply with the Test Anything Protocol.

* Issue #69: Cope with the lack of `AM_PROG_AR` in `configure.ac`, which
  first appeared in Automake 1.11.2.  Fixes a problem in Ubuntu 10.04
  LTS, which appears stuck in 1.11.1.

* Issue #24: Improve test case isolation by confining the tests to their
  own session instead of just to their own process group.


## Changes in kyua-cli version 0.7

**Experimental version released on October 18th, 2013.**

* Made failures from testers more resilent.  If a tester fails, the
  corresponding test case will be marked as broken instead of causing
  kyua to exit.

* Added the `--results-filter` option to the `report-html` command and
  set its default value to skip passed results from HTML reports.  This
  is to keep these reports more succint and to avoid generating tons of
  detail files that will be, in general, useless.

* Switched to use Lutok 0.3 to gain compatibility with Lua 5.2.

* Issue #69: Cope with the lack of `AM_PROG_AR` in `configure.ac`, which
  first appeared in Automake 1.11.2.  Fixes a problem in Ubuntu 10.04
  LTS, which appears stuck in 1.11.1.


## Changes in kyua-cli version 0.6

**Experimental version released on February 22nd, 2013.**

* Issue #36: Changed `kyua help` to not fail when the configuration file
  is bogus.  Help should always work.

* Issue #37: Simplified the `syntax()` calls in configuration and
  `Kyuafile` files to only specify the requested version instead of also
  the format name.  The format name is implied by the file being loaded, so
  there is no use in the caller having to specify it.  The version number
  of these file formats has been bumped to 2.

* Issue #39: Added per-test-case metadata values to the HTML reports.

* Issue #40: Rewrote the documentation as manual pages and removed the
  previous GNU Info document.

* Issue #47: Started using the independent testers in the `kyua-testers`
  package to run the test cases.  Kyua does not implement the logic to
  invoke test cases any more, which provides for better modularity,
  extensibility and robustness.

* Issue #57: Added support to specify arbitrary metadata properties for
  test programs right from the `Kyuafile`.  This is to make plain test
  programs more versatile, by allowing them to specify any of the
  requirements (allowed architectures, required files, etc.) supported
  by Kyua.

* Reduced automatic screen line wrapping of messages to the `help`
  command and the output of tables by `db-exec`.  Wrapping any other
  messages (specially anything going to stderr) was very annoying
  because it prevented natural copy/pasting of text.

* Increased the granularity of the error codes returned by `kyua(1)` to
  denote different error conditions.  This avoids the overload of `1` to
  indicate both "expected" errors from specific subcommands and
  unexpected errors caused by the internals of the code.  The manual now
  correctly explain how the exit codes behave on a command basis.

* Optimized the database schema to make report generation almost
  instantaneous.

* Bumped the database schema to 2.  The database now records the
  metadata of both test programs and test cases generically, without
  knowledge of their interface.

* Added the `db-migrate` command to provide a mechanism to upgrade a
  database with an old schema to the current schema.

* Removed the GDB build-time configuration variable.  This is now part
  of the `kyua-testers` package.

* Issue #31: Rewrote the `Kyuafile` parsing code in C++, which results in
  a much simpler implementation.  As a side-effect, this gets rid of the
  external Lua files required by `kyua`, which in turn make the tool
  self-contained.

* Added caching of various configure test results (particularly in those
  tests that need to execute a test program) so that cross-compilers can
  predefine the results of the tests without having to run the
  executables.


## Changes in kyua-testers version 0.1

**Experimental version released on February 19th, 2013.**

This is the first public release of the `kyua-testers` package.

The goal of this first release is to adopt all the test case execution
code of `kyua-cli` 0.5 and ship it as a collection of independent tester
binaries.  The `kyua-cli` package will rely on these binaries to run the
tests, which provides better modularity and simplicity to the
architecture of Kyua.

The code in this package is all C as opposed to the current C++ codebase
of `kyua-cli`, which means that the overall build times of Kyua are now
reduced.


## Changes in kyua-cli version 0.5

**Experimental version released on July 10th, 2012.**

* Issue #15: Added automatic stacktrace gathering of crashing test cases.
  This relies on GDB and is a best-effort operation.

* Issue #32: Added the `--build-root` option to the debug, list and test
  commands.  This allows executing test programs from a different
  directory than where the `Kyuafile` scripts live.  See the *Build roots*
  section in the manual for more details.

* Issue #33: Removed the `kyuaify.sh` script.  This has been renamed to
  atf2kyua and moved to the `kyua-atf-compat` module, where it ships as a
  first-class utility (with a manual page and tests).

* Issue #34: Changed the HTML reports to include the stdout and stderr of
  every test case.

* Fixed the build when using a "build directory" and a clean source tree
  from the repository.


## Changes in kyua-cli version 0.4

**Experimental version released on June 6th, 2012.**

* Added the `report-html` command to generate HTML reports of the
  execution of any recorded action.

* Changed the `--output` flag of the `report` command to only take a
  path to the target file, not its format.  Different formats are better
  supported by implementing different subcommands, as the options they
  may receive will vary from format to format.

* Added a `--with-atf` flag to the configure script to control whether
  the ATF tests get built or not.  May be useful for packaging systems
  that do not have ATF in them yet.  Disabling ATF also cuts down the
  build time of Kyua significantly, but with the obvious drawbacks.

* Grouped `kyua` subcommands by topic both in the output of `help` and
  in the documentation.  In general, the user needs to be aware of
  commands that rely on a current project and those commands that rely
  purely on the database to generate reports.

* Made `help` print the descriptions of options and commands properly
  tabulated.

* Changed most informational messages to automatically wrap on screen
  boundaries.

* Rewrote the configuration file parsing module for extensibility.  This
  will allow future versions of Kyua to provide additional user-facing
  options in the configuration file.

  No syntax changes have been made, so existing configuration files
  (version 1) will continue to be parsed without problems.  There is one
  little exception though: all variables under the top-level
  `test_suites` tree must be declared as strings.

  Similarly, the `-v` and `--variable` flags to the command line must
  now carry a `test_suites.` prefix when referencing any variables under
  such tree.


## Changes in kyua-cli version 0.3

**Experimental version released on February 24th, 2012.**

* Made the `test` command record the results of the executed test
  cases into a SQLite database.  As a side effect, `test` now supports a
  `--store` option to indicate where the database lives.

* Added the `report` command to generate plain-text reports of the
  test results stored in the database.  The interface of this command is
  certainly subject to change at this point.

* Added the `db-exec` command to directly interact with the store
  database.

* Issue #28: Added support for the `require.memory` test case property
  introduced in ATF 0.15.

* Renamed the user-specific configuration file from `~/.kyuarc` to
  `~/.kyua/kyua.conf` for consistency with other files stored in the
  `~/.kyua/` subdirectory.

* Switched to use Lutok instead of our own wrappers over the Lua C
  library.  Lutok is just what used to be our own utils::lua module, but
  is now distributed separately.

* Removed the `Atffile`s from the source tree.  Kyua is stable enough
  to generate trustworthy reports, and we do not want to give the
  impression that atf-run / atf-report are still supported.

* Enabled logging to stderr for our own test programs.  This makes it
  slightly easier to debug problems in our own code when we get a
  failing test.


## Changes in kyua-cli version 0.2

**Experimental version released on August 24th, 2011.**

The biggest change in this release is the ability for Kyua to run test
programs implemented using different frameworks.  What this means is
that, now, a Kyua test suite can include not only ATF-based test
programs, but also "legacy" (aka plain) test programs that do not use
any framework.  I.e. if you have tests that are simple programs that
exit with 0 on success and 1 on failure, you can plug them in into a
Kyua test suite.

Other than this, there have been several user-visible changes.  The most
important are the addition of the new `config` and `debug` subcommands
to the `kyua` binary.  The former can be used to inspect the runtime
configuration of Kyua after parsing, and the latter is useful to
interact with failing tests cases in order to get more data about the
failure itself.

Without further ado, here comes the itemized list of changes:

* Generalized the run-time engine to support executing test programs
  that implement different interfaces.  Test programs that use the ATF
  libraries are just a special case of this.  (Issue #18.)

* Added support to the engine to run `plain` test programs: i.e. test
  programs that do not use any framework and report their pass/fail
  status as an exit code.  This is to simplify the integration of legacy
  test programs into a test suite, and also to demonstrate that the
  run-time engine is generic enough to support different test
  interfaces.  (Issue #18.)

* Added the `debug` subcommand.  This command allows end users to tweak
  the execution of a specific test case and to poke into the behavior of
  its execution.  At the moment, all this command allows is to view the
  stdout and stderr of the command in real time (which the `test`
  command currently completely hides).

* Added the `config` subcommand.  This command allows the end user to
  inspect the current configuration variables after evaluation, without
  having to read through configuration files.  (Issue #11.)

* Removed the `test_suites_var` function from configuration files.  This
  was used to set the value of test-suite-sepecific variables, but it
  was ugly-looking.  It is now possible to use the more natural syntax
  `test_suites.<test-suite-name>.<variable> = <value>`.  (Issue #11.)

* Added a mechanism to disable the loading of configuration files
  altogether.  Needed for testing purposes and for scriptability.
  Available by passing the `--config=none` flag.

* Enabled detection of unused parameters and variables in the code and
  fixed all warnings.  (Issue #23.)

* Changed the behavior of "developer mode".  Compiler warnings are now
  enabled unconditionally regardless of whether we are in developer mode
  or not; developer mode is now only used to perform strict warning
  checks and to enable assertions.  Additionally, developer mode is now
  only automatically enabled when building from the repository, not for
  formal releases.  (Issue #22.)

* Fixed many build and portability problems to Debian sid with GCC 4.6.3
  and Ubuntu 10.04.1 LTS.  (Issues #20, #21, #26.)


## Changes in kyua-cli version 0.1

**Experimental version released on June 23rd, 2011.**

This is the first public release of the `kyua-cli` package.

The scope of this release is to provide functional replacement for the
`atf-run` utility included in the atf package.  At this point, `kyua`
can reliably run the NetBSD 5.99.53 test suite delivering the same
results as `atf-run`.

The reporting facilities of this release are quite limited.  There is
no replacement for `atf-report` yet, and there is no easy way of
debugging failing test programs other than running them by hand.  These
features will mark future milestones and therefore be part of other
releases.

Be aware that this release has suffered very limited field testing.
The test suite for `kyua-cli` is quite comprehensive, but some bugs may
be left in any place.

3.13.3 (2025-05-01)

Bug Fixes:

* When stubbing methods using the expect_any_instance_of or
  allow_any_instance_of ensure the stubbed method has the same visibility as
  the real method. (Jon Rowe, rspec/rspec-mocks#1596)
* Prevent recursive calls to stubbed methods during stub invocation. (James
  Dabbs, #116, #156)


3.13.4 (2025-05-05)

* Allow nested mock calls by changing an internal safeguard

# changes

* trap: Implement POSIX.1-2024 requirements by @magicant in #115
* read: Avoid crash in interactive shell by @magicant in #116
* history: Work around glibc's fsetpos bug by @magicant in #117
* add completion for make variant commands by @unrealapex in #110
* Update Git completion by @magicant in #120
* wait: Don't return when the target process is suspended by @magicant in #121
* Support POSIX.1-2024 read built-in behavior (except byte-wise field splitting) by @magicant in #123
* Change false, pwd, and true to substitutive built-ins by @c0d3-br3ak9r in #124
* Reject empty operand in cd built-in by @c0d3-br3ak9r in #126
* Ignore remaining commands after a foreground job stops by @magicant in #143
* Treat a job as suspended when any child process suspends by @magicant in #144
* Noglob when splitting $CDPATH at colons in cd and pushd completion by @magicant in #147
* add completion for fnf by @unrealapex in #140
* add completion for 'cmus' and 'cmus-remote' by @unrealapex in #141
* add completion for 'catgirl' by @unrealapex in #142
* Ignore SIGTSTP in process redirection subshells by @magicant in #148
* Add macOS workaround for test of suspended job by @magicant in #150
* Job control without a control terminal by @magicant in #149
* Discard remaining commands on shell errors if interactive by @magicant in #151
* Filter '.' and '..' from wglob results by @eilefsen in #152
* Report job number and PID for async commands in interactive shell by @magicant in #155
* Propagate signal exit status to parent process by @magicant in #156
* printf: Reject redundant character in numeric operand by @magicant in #157
* Reject multiple pathname expansion results in redirection operands by @magicant in #158
* Set interactive automatically even with positional parameters by @magicant in #160
* test: Reject -a, -o, and parentheses in POSIXly-correct mode by @magicant in #161
* Fix default exit status of exit built-in in trap action by @magicant in #162
* Keep empty tilde expansion from empty field removal by @magicant in #164
* Remove redundant trailing slash in tilde expansion by @magicant in #166
* Reject {n} redirection prefix by @magicant in #167
* Document hashondef and nolog options for POSIX.1-2024 by @magicant in #168
* Treatment of variables that should not be made readonly by @magicant in #169
* Reject making LINENO, OLDPWD, OPTARG, OPTIND, and PWD readonly by @magicant in #170

What's Changed

    feat: add just test-ci cmd to mimic ci testing locally by @anistark in #157
    refactor: restructure sbom command with format subcommands (spdx, cyclonedx) by @anistark in #156
    feat: validate sbom spdx and cyclonedx files by @anistark in #162
    feat: implement comprehensive SPDX standards compliance enhancements and character validation by @anistark in #163
    feat: add language parameter to GitHub Action by @anistark in #164
    fix: add CC0-1.0 license to compatibility matrix for all project licenses by @anistark in #165
    fix: exclude Go toolchain and version directives from dependency analysis by @anistark in #166
    feat: add filter to the TUI by @ashish10677 in #170
    chore: update dependencies by @anistark in #168
    feat: add sort feature to TUI and proper ascending/descending order by @anistark in #167
    refactor: move CI/CD examples to examples/ci directory by @anistark in #171
    Refactor/publish tag by @anistark in #172
    feat: add local-first license detection with --no-local flag for Node.js and Rust by @anistark in #173
    feat: ignore licenses and dependencies by @anistark in #175

What's Changed

    Bump clap from 4.4.16 to 4.4.17 by dependabot[bot] in #4
    Add .rustfmt.toml by akiomik in #5
    Bump nostr-sdk version to 0.27 by akiomik in #6
    Use nostr_sdk::Metadata instead of create::nostr::Metadata by akiomik in #7
    Use nip-21 by akiomik in #8
    Add NetBSD, fix typo and grammar by 0323pin in #9
    Bump clap from 4.4.17 to 4.4.18 by dependabot[bot] in #12
    Bump chrono from 0.4.31 to 0.4.33 by dependabot[bot] in #13
    Bump serde from 1.0.195 to 1.0.196 by dependabot[bot] in #15
    Bump serde_json from 1.0.111 to 1.0.113 by dependabot[bot] in #16
    Bump strum from 0.25.0 to 0.26.1 by dependabot[bot] in #14
    Bump config from 0.13.4 to 0.14.0 by dependabot[bot] in #18
    Bump tokio from 1.35.1 to 1.36.0 by dependabot[bot] in #20
    Bump ratatui version to v0.26.0 by akiomik in #21
    Bump ratatui from 0.26.0 to 0.26.1 by dependabot[bot] in #24
    Bump tui-widget-list from 0.7.0 to 0.7.1 by dependabot[bot] in #23
    Bump clap from 4.5.0 to 4.5.1 by dependabot[bot] in #27
    Bump chrono from 0.4.33 to 0.4.34 by dependabot[bot] in #22
    Bump serde_json from 1.0.113 to 1.0.114 by dependabot[bot] in #30
    Bump serde from 1.0.196 to 1.0.197 by dependabot[bot] in #29
    Bump mio from 0.8.10 to 0.8.11 by dependabot[bot] in #33
    Bump log from 0.4.20 to 0.4.21 by dependabot[bot] in #32
    Bump strum from 0.26.1 to 0.26.2 by dependabot[bot] in #36
    Bump chrono from 0.4.34 to 0.4.35 by dependabot[bot] in #35
    Bump clap from 4.5.1 to 4.5.2 by dependabot[bot] in #34
    Bump clap from 4.5.2 to 4.5.3 by dependabot[bot] in #39
    Bump color-eyre from 0.6.2 to 0.6.3 by dependabot[bot] in #38
    Bump regex from 1.10.3 to 1.10.4 by dependabot[bot] in #40
    Bump tokio from 1.36.0 to 1.37.0 by dependabot[bot] in #43
    Bump serde_json from 1.0.114 to 1.0.115 by dependabot[bot] in #42
    Bump chrono from 0.4.35 to 0.4.37 by dependabot[bot] in #41
    Bump h2 from 0.3.24 to 0.3.26 by dependabot[bot] in #44
    Bump clap from 4.5.3 to 4.5.4 by dependabot[bot] in #45
    Bump ratatui from 0.26.1 to 0.26.2 by dependabot[bot] in #48
    Bump rstest from 0.18.2 to 0.19.0 by dependabot[bot] in #46
    Bump chrono from 0.4.37 to 0.4.38 by dependabot[bot] in #47
    Bump serde from 1.0.197 to 1.0.198 by dependabot[bot] in #52
    Bump rustls from 0.21.10 to 0.21.11 in the cargo group across 1 directory by dependabot[bot] in #50
    Bump serde_json from 1.0.115 to 1.0.116 by dependabot[bot] in #51
    Bump human-panic from 1.2.3 to 2.0.0 by dependabot[bot] in #53
    Bump serde from 1.0.198 to 1.0.199 by dependabot[bot] in #55
    Bump unicode-width from 0.1.11 to 0.1.12 by dependabot[bot] in #54
    Bump tokio-util from 0.7.10 to 0.7.11 by dependabot[bot] in #59
    Bump serde from 1.0.199 to 1.0.200 by dependabot[bot] in #58
    Bump libc from 0.2.153 to 0.2.154 by dependabot[bot] in #56
    Bump serde_json from 1.0.116 to 1.0.117 by dependabot[bot] in #62
    Bump serde from 1.0.200 to 1.0.201 by dependabot[bot] in #61
    Fix clippy::assigning_clones by akiomik in #69
    Use rust-toolchainstable instead of nightly by akiomik in #68
    Bump serde from 1.0.201 to 1.0.203 by dependabot[bot] in #67
    Bump ratatui from 0.26.2 to 0.26.3 by dependabot[bot] in #65
    Bump libc from 0.2.154 to 0.2.155 by dependabot[bot] in #64
    Bump tokio from 1.37.0 to 1.38.0 by dependabot[bot] in #72
    Bump rstest from 0.19.0 to 0.21.0 by dependabot[bot] in #71
    Bump clap from 4.5.4 to 4.5.7 by dependabot[bot] in #76
    Bump regex from 1.10.4 to 1.10.5 by dependabot[bot] in #73
    Bump nostr-sdk version to 0.28.0 by akiomik in #77
    Bump unicode-width from 0.1.12 to 0.1.13 by dependabot[bot] in #75
    Bump nostr-sdk version to 0.29 by akiomik in #78
    Bump strum from 0.26.2 to 0.26.3 by dependabot[bot] in #81
    Bump lazy_static from 1.4.0 to 1.5.0 by dependabot[bot] in #79
    Bump clap from 4.5.7 to 4.5.8 by dependabot[bot] in #83
    Bump serde_json from 1.0.117 to 1.0.120 by dependabot[bot] in #85
    Bump serde from 1.0.203 to 1.0.204 by dependabot[bot] in #86
    Bump log from 0.4.21 to 0.4.22 by dependabot[bot] in #89
    Bump clap from 4.5.8 to 4.5.9 by dependabot[bot] in #92
    Bump serde_json from 1.0.120 to 1.0.121 by dependabot[bot] in #94
    Bump rstest from 0.21.0 to 0.22.0 by dependabot[bot] in #97
    Bump human-panic from 2.0.0 to 2.0.1 by dependabot[bot] in #98
    Bump serde_json from 1.0.121 to 1.0.125 by dependabot[bot] in #100
    Bump clap from 4.5.9 to 4.5.16 by dependabot[bot] in #102
    Bump libc from 0.2.155 to 0.2.158 by dependabot[bot] in #103
    Bump regex from 1.10.5 to 1.10.6 by dependabot[bot] in #104
    Bump tokio-util from 0.7.11 to 0.7.12 by dependabot[bot] in #105
    Bump pretty_assertions from 1.4.0 to 1.4.1 by dependabot[bot] in #107
    Bump serde_json from 1.0.125 to 1.0.132 by dependabot[bot] in #108
    Bump human-panic from 2.0.1 to 2.0.2 by dependabot[bot] in #109
    Bump config from 0.14.0 to 0.14.1 by dependabot[bot] in #110
    Bump sorted-vec from 0.8.3 to 0.8.5 by dependabot[bot] in #111
    Bump libc from 0.2.158 to 0.2.164 by dependabot[bot] in #112
    Bump futures from 0.3.30 to 0.3.31 by dependabot[bot] in #114
    Bump libc from 0.2.164 to 0.2.168 by dependabot[bot] in #116
    Bump chrono from 0.4.38 to 0.4.39 by dependabot[bot] in #117
    Bump tokio from 1.38.0 to 1.42.0 by dependabot[bot] in #118
    Bump tracing-error from 0.2.0 to 0.2.1 by dependabot[bot] in #119
    Bump serde from 1.0.204 to 1.0.217 by dependabot[bot] in #120
    Bump tracing-subscriber from 0.3.18 to 0.3.19 by dependabot[bot] in #121
    Bump serde_json from 1.0.132 to 1.0.137 by dependabot[bot] in #122
    Bump regex from 1.10.6 to 1.11.1 by dependabot[bot] in #123
    Bump log from 0.4.22 to 0.4.25 by dependabot[bot] in #124
    Bump libc from 0.2.168 to 0.2.169 by dependabot[bot] in #126
    Bump unicode-width from 0.1.13 to 0.2.0 by dependabot[bot] in #127
    Bump serde_json from 1.0.137 to 1.0.139 by dependabot[bot] in #128
    Bump libc from 0.2.169 to 0.2.170 by dependabot[bot] in #129
    Bump ring from 0.17.7 to 0.17.13 in the cargo group by dependabot[bot] in #130
    Bump config from 0.14.1 to 0.15.11 by dependabot[bot] in #131
    Bump chrono from 0.4.39 to 0.4.40 by dependabot[bot] in #133
    build: fix rust toolchain channel by akiomik in #135
    Bump tokio from 1.42.0 to 1.43.1 in the cargo group by dependabot[bot] in #134
    Bump log from 0.4.25 to 0.4.27 by dependabot[bot] in #136
    Bump tokio from 1.43.1 to 1.44.2 by dependabot[bot] in #137
    Bump clap from 4.5.16 to 4.5.18 by dependabot[bot] in #139
    Bump strum from 0.26.3 to 0.27.1 by dependabot[bot] in #140
    Bump chrono from 0.4.40 to 0.4.41 by dependabot[bot] in #141
    Bump sorted-vec from 0.8.5 to 0.8.6 by dependabot[bot] in #142
    Bump config from 0.15.11 to 0.15.13 by dependabot[bot] in #143
    build(deps): bump tracing-subscriber from 0.3.19 to 0.3.20 in the cargo group by dependabot[bot] in #145
    build(deps): bump tokio from 1.44.2 to 1.46.1 by dependabot[bot] in #144
    build(deps): bump serde from 1.0.217 to 1.0.226 by dependabot[bot] in #148
    build(deps): bump tokio-util from 0.7.12 to 0.7.16 by dependabot[bot] in #149
    build(deps): bump directories from 5.0.1 to 6.0.0 by dependabot[bot] in #150
    build(deps): bump color-eyre from 0.6.3 to 0.6.5 by dependabot[bot] in #151
    build(deps): bump serde from 1.0.226 to 1.0.228 by dependabot[bot] in #152
    fix: update human-panic API usage for v2.0 compatibility by akiomik in #153
    test: fix config test to work with existing config files by akiomik in #154
    build: upgrade Rust toolchain to 1.91.1 and fix clippy warnings by akiomik in #155
    feat: update TUI dependencies with API compatibility fixes by akiomik in #156
    refactor: migrate from deprecated ListableWidget to PreRender trait by akiomik in #157
    feat: update TUI dependencies to latest versions by akiomik in #158
    refactor: migrate to tui-widget-list ListView API and remove deprecated warnings by akiomik in #159
    feat: upgrade nostr-sdk to 0.31.0 with Tag API migration by akiomik in #160
    feat: add EventSet collection to replace manual event deduplication by akiomik in #161
    feat: upgrade nostr-sdk to 0.32.0 and fix TagStandard API changes by akiomik in #162
    feat: upgrade-nostr-sdk-to-0.33.0 by akiomik in #163
    feat: upgrade nostr-sdk to 0.35.0 and fix deprecated API usage by akiomik in #164
    feat: update nostr-sdk to 0.36.0 by akiomik in #165
    feat: upgrade nostr-sdk to 0.37.0 by akiomik in #166
    feat: upgrade nostr-sdk to 0.38.0 with API parameter fixes by akiomik in #167
    feat: upgrade to nostr-sdk 0.39.0 with separate timeline and profile subscriptions by akiomik in #168
    feat: upgrade to nostr-sdk 0.40.0 and simplify EventId::to_bech32() usage by akiomik in #169
    feat: upgrade nostr-sdk to 0.44.0 by akiomik in #170
    feat: add lib.rs by akiomik in #171
    ci: add spelling workflow by akiomik in #172
    chore: bump version to 0.1.1 by akiomik in #173

2.2.0
 - feat: blinking selected cell cursor by @thomas-mauran in #169
 - feat: improve the color selection popup by @thomas-mauran in #171
 - feat: allow engine to have an argument too by @thomas-mauran in #172
 - feat: deb build by @thomas-mauran in #173

2.1.2
 - build on intel macos

2.1.1
 - fix style for the vertical alignment of the left side number
 - fix the piece style with different scaling

2.1.0
 - ci: build for aarch64-macos, aarch64-linux and x64-windows as well by @jarjk in #162
 - feat: add sounds by @thomas-mauran in #161
 - feat: lichess + doc + disconnect by @thomas-mauran in #165
 - feat: bot auto install script and debug popup by @thomas-mauran in #166
 - docs: blog posts + releases blog posts by @thomas-mauran in #167

2.0.0
 - shakmaty integration by @tigerros in #137
 - feat: skins by @thomas-mauran in #152
 - Feat/move through history by @thomas-mauran in #153
 - Fix exit while hosting by @Andrada42 in #155
 - Feat/lichess by @thomas-mauran in #156

pkgsrc change: move MESSAGE to README.pkgsrc.


PEAR 1.10.17 (2025-12-14)

* PR #152: Fix HTTP chunked encoding handling
* PR #153: fix composer.json: typo in replace for pear_exception package
* PR #154: switch to https by default
* PR #156: Throw new Error instead of E_USER_ERROR on PHP 7.0+
* PR #159: update tests for https-first behavior